home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / COMM / INTERNET / MAIL / TRANSPORTS / TCP_IP / Docs / ReadMe < prev    next >
Text File  |  1995-11-23  |  11KB  |  232 lines
  1. Ant's NewsBase transport for Acorn TCP/IP
  2. =========================================
  3.  
  4. Documentation Changes
  5. ------------- -------
  6.  
  7. 1) I've changed the documentation on '*startup' as well as the comments in the file itself,
  8. to reflect what seems to be a recurring problem people have had setting up e-mail. If all
  9. your mail goes to 'postmaster', then you need to read it!
  10.  
  11. 2) Added some comments about !Groups. 
  12.  
  13. 3) Added a note about NewsBase 0.54n .
  14.  
  15. 4) Mentioned some future directions.
  16.  
  17. 5) Added a paragraph on the 'detect' error.
  18.  
  19.  
  20. Intro
  21. =====
  22.  
  23. This directory provides all the files needed to provide an NNTP and mail transport for
  24. NewsBase using Acorn's TCP/IP protocol suite wherever possible.
  25.  
  26. Retrieval and posting of Usenet news and posting of e-mail messages is done via a socket
  27. connection to an appropriate server, just like on real computers. :)
  28.  
  29. Retrieval of e-mail is necessarily file based, partly because this was the most convenient
  30. method for me, but mostly out of sheer idleness. However, read on.
  31.  
  32. Where I work, I fetch mail from a UNIX box via NFS, but this probably won't be a suitable
  33. method for you. Can I therefore recommend smtpd, an SMTP mail fetching module? You can use
  34. smtpd in conjunction with TCPIPtransport, for maximum news and mail happiness.
  35.  
  36.  
  37. Setting it all up
  38. =================
  39.  
  40. Firstly, set up NewsBase and an appropriate client (such as TTFN) so that they will work
  41. together. 
  42.  
  43. I ought to point out at this stage that this transport is intended for versions
  44. of NewsBase from 0.54m onwards. Behaviour with versions prior to this is not guaranteed.
  45. While we're on the subject of versions, you'll also need version 4.02 of the Internet
  46. module or later, although since the BSD socket interface is pretty much carved in stone, you
  47. ought to be able to get away with earlier versions.
  48.  
  49. Research has been conducted into whether this transport will work with FreeNet. Apparently,
  50. it does.
  51.  
  52. Clearly, you'll also need some kind of reliable connection to an internet host which likes
  53. you, (ie lets you send/receive news and e-mail) otherwise you're wasting your time.
  54. You can specify different hosts for mail and news, if you want to.
  55.  
  56. For the record, this TCP/IP transport expects to be able to find the services 'smtp' and
  57. 'nntp', and it'll want to connect to them using tcp. udp is a big no no. 
  58.  
  59.  
  60. Once you've got NewsBase working, copy the TCP/IP directory (the one with the transport
  61. stuff in) into NewsBase's Transports directory (which you'll find inside the NewsBase
  62. application.) 
  63.  
  64. Avoiding the dreaded 'detect' error
  65. -----------------------------------
  66.  
  67. At this point you need to edit NewsBase's !Run file. Just before the line:
  68.  
  69.     run <NewsBase$dir>.!RunImage %*0
  70.     
  71. you need to insert the line:
  72.  
  73.     run <NewsBase$Dir>.Transports.TCP/IP.startup
  74.     
  75. this ensures that the TCPIPtransport module is loaded before NewsBase is run. Otherwise,
  76. NewsBase will complain with the error 'detect not found', because the detect command is in
  77. the TCPIPtransport module, and if NewsBase can't 'detect' the transport, it doesn't get
  78. loaded, and so on.    
  79.  
  80. Now then, inside this directory there are two files you can edit, namely "!Startup" and
  81. "params". Caveat Editor, however - the slightest slip in one of these files and you'll
  82. have a sullen and unwilling newsreader on your hands!
  83.  
  84.  
  85. !StartUp
  86. ========
  87.  
  88. Being a helpful sort of person, I've included a lot of comments in this file, and as a bonus
  89. each variable employed in it has a conveniently descriptive name. Therefore, I shall only
  90. make a couple of observations. 
  91.  
  92. Firstly, don't edit the variables which the files says not to edit. 
  93.  
  94. The variable 'TCPIPTransport$MailUser' is the name of a temporary file within which the 
  95. TCP/IP transport stores your batched e-mail, until NewsBase has a chance to look at it. I've
  96. pointed out that setting this variable to 'news' would be a bad idea, as 'news' is the root
  97. of the filenames used to store batched news articles.
  98.  
  99. NB: the name you choose for this file is important - it's the user name which NewsBase will attempt
  100. to deliver the mail to. So for example, if your NewsBase username is 'chris' you need to set this
  101. variable to 'chris' also. If for example your NewsBase username was the more formal 'jbloggs', but
  102. you set TCPIPTransport$MailUser to 'joe' NewsBase will be confused, and it'll divert any mail it 
  103. finds to the postmaster account. If you examine the NewsBase log and find lines like 'user joe
  104. not found, redirecting to postmaster' then you're probably suffering from this kind of prblem.
  105.  
  106.  
  107. The variable 'TCPIPTransport$DomainName' should be something which is meaningful outside your
  108. local network, ie something with significance to the internet in general. Typically, this will
  109. be related to the name you have given for TCPIPTransport$MailHost.
  110.  
  111. The variable 'TCPIPTransport$MailFile' points to a file wherein the TCP/IP transport expects to 
  112. find your incoming mail. Note that this is not a batch file, but your bog standard UNIX mailbox.
  113. Note that it is possible to get NewsBase to read you Intray directly by fiddling with the params
  114. file. However, I have provided this extra layer because my UNIX box gets very excited if my mail
  115. file is deleted, which is what NewsBase does when it has finished reading it. Therefore, the 
  116. TCP/IP transport reads and empties the specified file, but doesn't delete it - it just sets its
  117. size to zero.
  118.  
  119. If you don't want to use this, then just set this variable to something bogus.
  120.  
  121.  
  122. The variable 'TCPIPTransport$MailHost' must contain the hostname (as known to your machine) of a
  123. friendly computer with an SMTP server, ie one which will allow you to post e-mail. 
  124.  
  125. Similarly, 'TCPIPTransport$NewsHost' should contain the name of a computer which is prepared to 
  126. let you rifle through it's horde of news, and to post acrimoniously in its name.
  127.  
  128. And that, my friends, is that. Onward then, to ...
  129.  
  130. "params"
  131. ========
  132.  
  133.  
  134. Very little needs changing in this file - in fact there is only one thing you can usefully change
  135. without destroying the delicate balance upon which this transport is based. See that line:
  136.  
  137.         getnews 0 getnews -t 1 -l 100
  138.         
  139. Those numbers are the bits you can change if you want. The number after '-t' represents
  140. the period in hours between news debatches. I'd better explain. 
  141.  
  142. When you click on the 'debatch' option in the NewsBase menu (or when it does it automatically, if you
  143. have it so configured) NewsBase prods the selected transport into life to fetch news and e-mail.
  144. The command 'getmail' fetches your email, and the command 'getnews' fetches your Usenet news.
  145. Unfortunately, Newsbase often calls both of these, even if you only wanted one of them.
  146. Now then, since you want to be able to retrieve e-mail as quickly as possible, but you don't want to
  147. be debatching news every time (a long and involved process!), 'getnews' will examine the timeout value 
  148. you've given it, to see if it last debatched news within that time. If not, it'll go off and search out 
  149. some news. For example, if you have the timeout set to 1, and click on debatch, the program will debatch 
  150. both mail and news. Clicking on debatch again, say 15 minutes later, will cause the command to return
  151. without doing anything, as the period you specified hasn't elapsed yet.
  152.  
  153. If you _do_ want 'getnews' to fetch new news every time it's called, you can use '-t 0' as the first
  154. parameter.
  155.  
  156. The '-l' option governs what happens when you subscribe to a new group for the first time. The number
  157. indicates how many of the most recent postings you want to receive when you first read the group.
  158. This is to avoid the situation of your poor machine having to download 100,000 articles from the
  159. server when you first subscribe to that seedy alt.*.binaries group - instead it'll just get the 100
  160. (or whatever) most recent files. 
  161.  
  162.  
  163. At this point, all things being well, NewsBase should have sussed that there's a new kid on the block.
  164. From the transport set up panel, you ought to be able to select and 'setup' the TCP/IP transport, as 
  165. you would any other.
  166.  
  167. If you click on the 'setup' icon in NewsBase's transport set up dialog, the TCP/IP transport will
  168. attempt to create a default list of news groups, and run the 'Startup' file. Do not be alarmed.
  169. Also, 'setup' will contact your specified NNTP server and download a complete list of available
  170. newsgroups, which it will save to the file '<TCPIPTransport$SupportDir>.allgroups', which you may
  171. want to refer to if you're using !Groups.
  172.  
  173.  
  174. Which newsgroups do you want to read?
  175. =====================================
  176.  
  177. Inside the TCP/IP transport directory, there's another directory called 'lib', and in that there's
  178. a file called newsgroups, among others. 'Newsgroups' contains the list of newsgroups which the 
  179. TCP/IP transport will examine. Note that this is not the same thing as your list of subscribed to
  180. groups - that is purely a function of the news reading client. This list represents the totality
  181. of newsgroups which are available on the target machine - you may decide to subscribe to only a
  182. handful of them. 
  183.  
  184. Realistically though, if you're using NewsBase for a single-user set up, you might as well just stick
  185. the groups you're interested in in this file, coz it'll save time during debatching. To minimize annoyance
  186. to other users who might copy this transport of you though, please do not edit the file 'default_ng'.
  187. This file is used to generate the 'newsgroups' file when the TCP/IP transport is first run.
  188.  
  189. Oh yes, I forgot to mention, the format of the newsgroups file is:
  190.  
  191. <newsgroup>        <last article seen in that group>
  192.  
  193.  
  194. The newsgroup must be a proper newsgroup title, ie a bunch of words with dots in, and the article number
  195. must follow on the same line, separated by some white space. This number represents an NNTP article number,
  196. if anyone's interested.
  197.  
  198. You can put comments in this file too, as long as you start 'em with a #.
  199.  
  200.  
  201. What's this module then?
  202. ========================
  203.  
  204. Graham has thoughtfully made provision for all the transport programs to sit in a module, so that's what
  205. I've done. Previously they were all separate apps, and took up about 150k between them, but the module
  206. only takes up 30k, and theoretically is a bit quicker off the mark.
  207.  
  208. The module provides full help on itself, but basically it provides the commands addgroup, delgroup, detect,
  209. getmail, getnews, listgroups, mkgroups, sethost, setremote, sendnews, and sendmail. All these have help info,
  210. but I wouldn't recommend using them from the command line, except possibly 'listgroups' which has no 
  211. direct equivalent from within NewsBase (it's normally called during 'setup'.)
  212.  
  213.  
  214.  
  215. I've set it all up and it doesn't work.
  216. =======================================
  217.  
  218. Are you using NewsBase 0.54n ? If so, it has a bug which prevents certain transports from working, and sadly
  219. this affects TCPIPtransport. It's relatively easy to fix, but far be it from me to publish nasty hacks of
  220. Graham's code. :)  Get a newer version of NewsBase (not possible at time of writing) or contact Graham for
  221. a fix. NewsBase 0.55pre10 also doesn't work out of the box with TCPIPtransport, and requires a few subtle
  222. modifications.
  223.  
  224. Well, I think that's about it! Hope you enjoy it, and if you have any problems, e-mail Graham and I'm sure
  225. he'll sort them out for you! :)
  226.  
  227.  
  228. Ant.
  229. 26/6/95
  230.  
  231.  
  232.